Remove markdownlint #522
Merged
Remove markdownlint #522
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
- Move proper-names rule from root to docs-specific config so it only applies to user-facing documentation, not prompts/skills - Add proseWrap: never for LLM-consumed files (AGENTS.md, .claude/, .github/prompts/) to avoid hard-wrapping prompt content - Remove .claude/ from prettierignore so basic formatting still applies - Update markdownlint schema version to match installed version Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
Markdownlint doesn't support MDX files so it effectively does nothing anymore. Attempted to replace it with remark-lint but that caused more problems than it solved.
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
Contributor
There was a problem hiding this comment.
Pull request overview
This PR removes markdownlint from the project since all documentation files are .mdx (which markdownlint doesn't support), and it was only linting repository metadata files. The PR consolidates linting to Prettier and ESLint only, simplifying the tooling setup.
Changes:
- Removed markdownlint-cli2 package and all
.markdownlint*.jsonconfiguration files - Added
@eslint/compatpackage and configured ESLint to respect.gitignoreviaincludeIgnoreFile - Configured Prettier with
proseWrap: neverfor LLM-consumed files (.claude/,AGENTS.md,.github/prompts/) to preserve intentional line breaks - Updated all references to markdownlint in documentation, CI workflows, editor configurations, and developer tooling
Reviewed changes
Copilot reviewed 20 out of 21 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| package.json | Removed markdownlint scripts and dependency; added @eslint/compat |
| package-lock.json | Updated lockfile to reflect dependency changes |
| eslint.config.mjs | Added includeIgnoreFile to respect .gitignore; disabled mdx/remark auto-fix |
| .prettierrc | Added proseWrap: never override for LLM-consumed files |
| .prettierignore | Removed .claude/ ignore (now formatted by Prettier) |
| .lintstagedrc | Removed markdownlint from .md file linting pipeline |
| .markdownlint.json | Deleted root markdownlint configuration |
| .markdownlint-cli2.jsonc | Deleted CLI configuration |
| docs/toolhive/.markdownlint.json | Deleted docs-specific configuration |
| docs/toolhive/_partials/.markdownlint.json | Deleted partials-specific configuration |
| docs/toolhive/reference/cli/.markdownlint.json | Deleted CLI reference configuration |
| .github/workflows/_static-checks.yaml | Removed markdownlint CI check |
| .vscode/extensions.json | Removed markdownlint VS Code extension |
| .devcontainer/devcontainer.json | Removed markdownlint extension from devcontainer |
| renovate.json | Updated linter package pattern (removed markdownlint*, added remark-*) |
| README.md | Updated formatting instructions to remove markdownlint references |
| STYLE-GUIDE.md | Removed markdownlint reference and inline disable comment |
| AGENTS.md | Updated linting documentation to reflect new setup |
| .github/prompts/doc-review.prompt.md | Updated linting instructions |
| .claude/skills/test-docs/SKILL.md | Reformatted with proseWrap: never |
| src/components/ProductCard/README.md | Removed inline markdownlint disable comment |
JAORMX
approved these changes
Feb 5, 2026
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
Removes markdownlint from the project. Since all documentation files are
.mdx(which markdownlint doesn't support), it was only linting repo metadata files like README.md.Changes:
.markdownlint*.jsonconfig filesincludeIgnoreFileto ESLint config to respect.gitignoreproseWrap: neverin Prettier for LLM-consumed files (.claude/,AGENTS.md,.github/prompts/) to preserve intentional line breaksNew linting setup:
.mdfiles: Prettier only.mdxfiles: Prettier + ESLint.js,.jsx,.ts,.tsxfiles: Prettier + ESLintType of change
Submitter checklist
Content and formatting